home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAutoCompleteResult.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.3 KB  |  98 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is mozilla.org code.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Netscape Communications Corporation.
  18.  * Portions created by the Initial Developer are Copyright (C) 2001
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *   Joe Hewitt <hewitt@netscape.com> (Original Author)
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. [scriptable, uuid(eb43e1dc-2060-4d8e-aebf-3efec4e21cf8)]
  41. interface nsIAutoCompleteResult : nsISupports
  42. {
  43.   /**
  44.    * Possible values for the searchResult attribute
  45.    */
  46.   const unsigned short RESULT_IGNORED = 1; /* indicates invalid searchString */
  47.   const unsigned short RESULT_FAILURE = 2; /* indicates failure */
  48.   const unsigned short RESULT_NOMATCH = 3; /* indicates success with no matches */
  49.   const unsigned short RESULT_SUCCESS = 4; /* indicates success with matches */
  50.  
  51.   /**
  52.    * The original search string
  53.    */
  54.   readonly attribute AString searchString;
  55.  
  56.   /**
  57.    * The result of the search
  58.    */
  59.   readonly attribute unsigned short searchResult;
  60.  
  61.   /**
  62.    * Index of the default item that should be entered if none is selected
  63.    */
  64.   readonly attribute long defaultIndex;
  65.  
  66.   /**
  67.    * A string describing the cause of a search failure
  68.    */
  69.   readonly attribute AString errorDescription;
  70.  
  71.   /**
  72.    * The number of matches
  73.    */
  74.   readonly attribute unsigned long matchCount;
  75.  
  76.   /**
  77.    * Get the value of the result at the given index
  78.    */
  79.   AString getValueAt(in long index);
  80.  
  81.   /**
  82.    * Get the comment of the result at the given index
  83.    */
  84.   AString getCommentAt(in long index);
  85.  
  86.   /**
  87.    * Get the style hint for the result at the given index
  88.    */
  89.   AString getStyleAt(in long index);
  90.  
  91.   /**
  92.    * Remove the value at the given index from the autocomplete results.
  93.    * If removeFromDb is set to true, the value should be removed from
  94.    * persistent storage as well.
  95.    */
  96.   void removeValueAt(in long rowIndex, in boolean removeFromDb);
  97. };
  98.